权限(Permission)

[POST] /api/v2/permission/documents/{id}/update

更新文档权限

参数

名称	类型	位于	描述
id必填项	string	path	文档Id

请求格式

PermissionRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未找到

ServerPluginError

[POST] /api/v2/permission/documents/batch-update

批量修改文档的权限

请求格式

BatchChangePermissionRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未找到

ServerPluginError

[POST] /api/v2/permission/documents/{id}/apply-min-needed-permission

授权当前文档的 最小引用文档权限

参数

名称	类型	位于	描述
id必填项	string	path	文档Id

请求格式

MinNeededPermissionRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未找到

ServerPluginError

[POST] /api/v2/permission/documents/batch-apply-min-needed-permission

批量授权指定文档的 最小引用文档权限

请求格式

BatchApplyMinNeededPermissionRequestModel

响应

状态代码: 200

成功

DocumentResponseModel

状态代码: 204

成功

状态代码: 400

错误请求

ServerPluginError

状态代码: 404

未找到

ServerPluginError

[GET] /api/v2/identity/permissions

获取所有权限

参数

名称	类型	位于	描述
enabled	Boolean	query	是否仅获取启用的权限，例如：true

响应

状态代码: 200

成功

PermissionModel

模型定义

Ƭ DocumentResponseModel

文档返回模型

名称	类型	描述	示例
documentId可为空	string	文档Id
title可为空	string	文档标题
fileExt可为空	string	文档扩展名
contentType可为空	string	文档类型
creatorName可为空	string	创建者名称
modifierName可为空	string	修改者名称
deleterName可为空	string	删除者名称
description可为空	string	文档描述信息
isSystemReserved可为空	Boolean	是否为系统预留文档
isResource	Boolean	文档是否为资源
hideOnMobile可为空	Boolean	是否在移动端隐藏
meta可为空	string	文档元数据信息（Meta）
hideInDocumentPortal可为空	Boolean	在门户站点中隐藏该文件
organizationId可为空	string	文档组织Id
organizationIdPath可为空	string	文档组织Id路径
thumbnail可为空	string	文档缩略图
schemaVersion可为空	string	文档版本

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述	示例
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ PermissionRequestModel

权限请求模型

名称	类型	描述	示例
grantCollection可为空	AccessEntryStringDto	授权的权限集合
revokeCollection可为空	AccessEntryStringDto	需要撤销的权限集合

Ƭ AccessEntryStringDto

访问权限字符串

名称	类型	描述	示例
role可为空	string	角色名称	"Tester"
ops可为空	Array<string>	操作: / 执行: ["Execute"] / 读取: ["Execute", "Read"] / 写入: ["Execute", "Read", "Update"]	["Execute","Read","Update"]

Ƭ BatchChangePermissionRequestModel

批量修改文档权限模型

名称	类型	描述	示例
documentIds可为空	Array<string>	需要修改权限的文档Id	["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]
operationType可为空	string	操作类型(AddNew/RemoveExisting/RemoveExistingAndAddNew)	"AddNew"
grantCollection可为空	AccessEntryStringDto	被授权的权限集合

Ƭ MinNeededPermissionRequestModel

获取当前文档请求模型的 最小文档引用权限

名称	类型	描述	示例
role可为空	string	Role name	"Tester"

Ƭ BatchApplyMinNeededPermissionRequestModel

批量获取当前文档请求模型的 最小文档引用权限

名称	类型	描述	示例
documentIds可为空	Array<string>	文档Ids	["1FB74CF4-FFB0-492F-A2D5-29AA761955CF","DD695D78-015D-43E2-9F3A-8919F4F534FE"]
roleNames可为空	Array<string>	角色名称	["Tester","Viewer"]

Ƭ PermissionModel

名称	类型	描述	示例
name可为空	string
description可为空	string
enabled	Boolean
order	int32
module可为空	string
category可为空	string
isCustomPermission	Boolean